Skip to main content

SMS Providers Configuration Test

SMS Providers Configuration Test

Path Parameters
    workspaceName string required
    providerName string required

Request Body

accountsidstring

Identifier of the sms provider.

authtokenstring

Auth token of the sms Provider.

fromstring

Phone number that the message need to be send from.

phoneNumberstring

Test phone number.

Sample Request Body
 {
"accountsid":"accountsid",
"authtoken":"sender phoneNumber",
"from":"sender phoneNumber",
"phoneNumber":"99XXXXXXXX"
}

Response

messagestring

Error message if the test is not successful

successboolean

true/false based on the test.

Sample Response
{
"success":true,
"message":""
}
HTTP STATUS CODE SUMMARY
200 - OKSuccessfully done.
201 - OKSuccessfully created.
400 - Bad RequestThe request was unacceptable, often due to missing a required parameter.
401 - UnauthorizedUnauthorized access try with correct access.
402 - Request FailedThe parameters were valid but the request failed.
403 - ForbiddenThe Application doesn't have permissions to perform the request.
404 - Not FoundThe requested resource doesn't exist
500 - Server ErrorsSomething went wrong on ezto auth's end. (These are rare.)
503 - Server ErrorsService temporarily unavailable

Loading...